Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DESENG-651 Update pr template, contributing guide #2570

Merged
merged 2 commits into from
Jul 31, 2024
Merged

Conversation

Baelx
Copy link
Collaborator

@Baelx Baelx commented Jul 31, 2024

Issue #: https://citz-gdx.atlassian.net/browse/DESENG-651

Description of changes:

  • Update PR template to remove license-related contribution dislcaimer
  • Add common components, more instructions, style guide to contributing.md

Copy link
Contributor

@NatSquared NatSquared left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks for helping us stay on top of documentation :)



By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the met-public license (Apache 2.0).
**User Guide update ticket (if applicable):**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for getting rid of that boilerplate! and I like the forward thinking with user guide ticket integration

- Widespread incorrect syntax use (using snake case for many variables in JS when it's not required)
- Significant amount of repeition in code that can be condensed without much issue (code isn't DRY) *
- Unnecessary function calls, overly verbose code *

## Style Guide

- Avoid using CSS directly. Instead, style through Material UI theming or with CSS-in-JS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed :)

CONTRIBUTING.md Outdated
### MET Web

- Be sure to make use of shared components found under `src/components/common`. Below is a non-exhaustive list of common app components:
- `PrimaryButton`, `SecondaryButton`, `TertiaryButton`: Buttons that come with built-in MET theming and functionality
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preferred way to use these is to import the one <Button> component from components/common and use variant=<"primary"|"secondary"|"tertiary"|undefined>

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sharing that knowledge! I'll update

Copy link

sonarcloud bot commented Jul 31, 2024

@Baelx Baelx merged commit 2cd56b4 into main Jul 31, 2024
4 checks passed
@Baelx Baelx deleted the task/deseng651 branch July 31, 2024 01:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants